@types/classnames

What is @types/classnames?

The @types/classnames package provides TypeScript type definitions for the classnames library, which is a utility for conditionally joining classNames together. This package is useful for TypeScript users who want to ensure type safety when using classnames to dynamically generate class strings based on certain conditions.

What are @types/classnames's main functionalities?

Basic usage with strings

Combine multiple class names into a single string.

classNames('foo', 'bar'); // 'foo bar'

Using objects to conditionally apply classes

Apply classes based on the truthiness of the associated value.

classNames({ 'foo': true, 'bar': false }); // 'foo'

Combining types

Mix strings and objects to conditionally apply classes.

classNames('foo', { 'bar': true }, 'baz', { 'qux': false }); // 'foo bar baz'

Using arrays

Pass arrays of class names to be joined together.

classNames(['foo', 'bar'], ['baz']); // 'foo bar baz'

Other packages similar to @types/classnames

clsx

clsx is a tiny utility for constructing className strings conditionally. It is similar to classnames but offers a more optimized, faster implementation with a smaller footprint.

emotion

Emotion is a performant and flexible CSS-in-JS library. While primarily focused on styling components, it includes the `cx` function, which is similar to classnames for combining class names based on conditions.

README

This is a stub types definition for @types/classnames (https://github.com/JedWatson/classnames#readme).

classnames provides its own type definitions, so you don't need @types/classnames installed!